docs: Mintlify MDX docs + docs.json; bump Speakeasy to 1.787.0#382
Merged
Conversation
Enable Speakeasy's Mintlify documentation mode and wire this repo up as a Mintlify multi-repo source. The mintlify mdx emitter for the Python generator landed in generator v0.11.0 (Speakeasy CLI 1.787.0), so this also bumps the pinned speakeasyVersion and regenerates the SDK source. - workflow.yaml: speakeasyVersion 1.680.0 -> 1.787.0 - gen.yaml: add `documentation: mintlify` (Python generator now 0.11.0) - docs/: Mintlify `.mdx` output (natural Speakeasy tree) - docs/docs.json: hand-written secondary-source config (theme, name, colors, navigation listing the 27 service pages + overview). Type pages are left out of nav and served by Mintlify as hidden-but-reachable pages - docs/overview.mdx: install + quickstart landing page - .genignore: protect docs/docs.json and docs/overview.mdx from regeneration - .gitignore: stop ignoring /docs so the generated tree is committed - SDK source regenerated by the generator bump; pyproject version 0.10.8 -> 0.11.0 and requires-python >=3.9.2 -> >=3.10 Verified locally: `uv build`, `mypy src` (700 files, clean), `pyright src` (0 errors) all pass.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enable Speakeasy's Mintlify documentation mode and wire this repo up as a Mintlify multi-repo source (mirrors typescript-sdk and go-sdk).
The mintlify mdx emitter for the Python generator landed in generator v0.11.0 (Speakeasy CLI 1.787.0), so enabling docs here also bumps the pinned
speakeasyVersionand regenerates the SDK source.workflow.yaml:speakeasyVersion1.680.0 → 1.787.0gen.yaml: adddocumentation: mintlify(Python generator now 0.11.0)docs/: Mintlify.mdxoutput in Speakeasy's natural tree (sdks/<tag>/README.mdx,models/,operations/,errors/,components/)docs/docs.json: hand-written secondary-source config —theme,name: "Python SDK",colors, navigation listing the 27 service pages + overview. Type pages are left out of nav and served by Mintlify as hidden pages.docs/overview.mdx: install + quickstart landing page..genignore: adddocs/docs.json+docs/overview.mdxso regeneration won't overwrite them..gitignore: remove/docsso the generated tree is committed (was previously ignored).SDK source changes (from the generator bump)
0.10.8 → 0.11.0 regenerated source (432
.pyfiles modified, +15k/−7.9k):pyproject.toml: version 0.10.8 → 0.11.0;requires-python>=3.9.2→>=3.10(drops 3.9 support); pydantic capped<2.13Verification
Ran the same checks as CI's
pr-validationworkflow locally, all green:uv build→ buildsopenrouter-0.11.0wheel + sdist ✓uv run --group dev mypy src→ no issues in 700 source files ✓uv run --group dev pyright src→ 0 errors, 0 warnings ✓Test plan
pr-validation(build + mypy + pyright) greenrequires-python >=3.10) is acceptablespeakeasy runand confirm docs.json + overview.mdx survive (.genignore)